/*
 * SD-SPI Protocol Conversion - BCMSDH->SPI Translation Layer
 *
 * Copyright (C) 1999-2019, Broadcom.
 *
 *      Unless you and Broadcom execute a separate written software license
 * agreement governing use of this software, this software is licensed to you
 * under the terms of the GNU General Public License version 2 (the "GPL"),
 * available at http://www.broadcom.com/licenses/GPLv2.php, with the
 * following added to such license:
 *
 *      As a special exception, the copyright holders of this software give you
 * permission to link this software with independent modules, and to copy and
 * distribute the resulting executable under terms of your choice, provided that
 * you also meet, for each linked independent module, the terms and conditions
 * of the license of that module.  An independent module is a module which is
 * not derived from this software.  The special exception does not apply to any
 * modifications of the software.
 *
 *      Notwithstanding the above, under no circumstances may you combine this
 * software in any way with any other Broadcom software provided under a license
 * other than the GPL, without Broadcom's express prior written consent.
 *
 *
 * <<Broadcom-WL-IPTag/Open:>>
 *
 * $Id: bcmsdspi.h 514727 2014-11-12 03:02:48Z $
 */
#ifndef _BCM_SD_SPI_H
#define _BCM_SD_SPI_H

/* global msglevel for debug messages - bitvals come from sdiovar.h */

#define sd_err(x)
#define sd_trace(x)
#define sd_info(x)
#define sd_debug(x)
#define sd_data(x)
#define sd_ctrl(x)

#define sd_log(x)

#define SDIOH_ASSERT(exp)                                                      \
    do {                                                                       \
        if (!(exp))                                                            \
            printf("!!!ASSERT fail: file %s lines %d", __FILE__, __LINE__);    \
    } while (0)

#define BLOCK_SIZE_4318 64
#define BLOCK_SIZE_4328 512

/* internal return code */
#define SUCCESS 0
#undef ERROR
#define ERROR 1

/* private bus modes */
#define SDIOH_MODE_SPI 0

#define USE_BLOCKMODE 0x2 /* Block mode can be single block or multi */
#define USE_MULTIBLOCK 0x4

struct sdioh_info {
    uint cfg_bar;     /* pci cfg address for bar */
    uint32 caps;      /* cached value of capabilities reg */
    uint bar0;        /* BAR0 for PCI Device */
    osl_t *osh;       /* osh handler */
    void *controller; /* Pointer to SPI Controller's private data struct */

    uint lockcount;             /* nest count of sdspi_lock() calls */
    bool client_intr_enabled;   /* interrupt connnected flag */
    bool intr_handler_valid;    /* client driver interrupt handler valid */
    sdioh_cb_fn_t intr_handler; /* registered interrupt handler */
    void *intr_handler_arg;     /* argument to call interrupt handler */
    bool initialized;           /* card initialized */
    uint32 target_dev;          /* Target device ID */
    uint32 intmask;             /* Current active interrupts */
    void *sdos_info;            /* Pointer to per-OS private data */

    uint32 controller_type; /* Host controller type */
    uint8 version;          /* Host Controller Spec Compliance Version */
    uint irq;               /* Client irq */
    uint32 intrcount;       /* Client interrupts */
    uint32 local_intrcount; /* Controller interrupts */
    bool host_init_done;    /* Controller initted */
    bool card_init_done;    /* Client SDIO interface initted */
    bool polled_mode;       /* polling for command completion */

    bool sd_use_dma;      /* DMA on CMD53 */
    bool sd_blockmode;    /* sd_blockmode == FALSE => 64 Byte Cmd 53s. */
                          /*  Must be on for sd_multiblock to be effective */
    bool use_client_ints; /* If this is false, make sure to restore */
    bool got_hcint;       /* Host Controller interrupt. */
                          /*  polling hack in wl_linux.c:wl_timer() */
    int adapter_slot;     /* Maybe dealing with multiple slots/controllers */
    int sd_mode;          /* SD1/SD4/SPI */
    int client_block_size[SDIOD_MAX_IOFUNCS]; /* Blocksize */
    uint32 data_xfer_count; /* Current register transfer size */
    uint32 cmd53_wr_data;   /* Used to pass CMD53 write data */
    uint32 card_response;   /* Used to pass back response status byte */
    uint32 card_rsp_data;   /* Used to pass back response data word */
    uint16 card_rca;        /* Current Address */
    uint8 num_funcs;        /* Supported funcs on client */
    uint32 com_cis_ptr;
    uint32 func_cis_ptr[SDIOD_MAX_IOFUNCS];
    void *dma_buf;
    ulong dma_phys;
    int r_cnt; /* rx count */
    int t_cnt; /* tx_count */
};

/************************************************************
 * Internal interfaces: per-port references into bcmsdspi.c
 */

/* Global message bits */
extern uint sd_msglevel;

/**************************************************************
 * Internal interfaces: bcmsdspi.c references to per-port code
 */

/* Register mapping routines */
extern uint32 *spi_reg_map(osl_t *osh, uintptr addr, int size);
extern void spi_reg_unmap(osl_t *osh, uintptr addr, int size);

/* Interrupt (de)registration routines */
extern int spi_register_irq(sdioh_info_t *sd, uint irq);
extern void spi_free_irq(uint irq, sdioh_info_t *sd);

/* OS-specific interrupt wrappers (atomic interrupt enable/disable) */
extern void spi_lock(sdioh_info_t *sd);
extern void spi_unlock(sdioh_info_t *sd);

/* Allocate/init/free per-OS private data */
extern int spi_osinit(sdioh_info_t *sd);
extern void spi_osfree(sdioh_info_t *sd);

#endif /* _BCM_SD_SPI_H */
